Summary

Fully Qualified Name:	Laminas\ModuleManager\Listener\ListenerOptions
Extends:	AbstractOptions

Description

Methods

Name	Description	Defined By
__construct()	Constructor	AbstractOptions
__get()	Get a configuration property	AbstractOptions
__isset()	Test if a configuration property is null	AbstractOptions
__set()	Set a configuration property	AbstractOptions
__unset()	Set a configuration property to NULL	AbstractOptions
getCacheDir()	Get the path where cache file(s) are stored	ListenerOptions
getCheckDependencies()	Set whether to check dependencies during module loading or not	ListenerOptions
getConfigCacheEnabled()	Check if the config cache is enabled	ListenerOptions
getConfigCacheFile()	Get the path to the config cache	ListenerOptions
getConfigCacheKey()	Get key used to create the cache file name	ListenerOptions
getConfigGlobPaths()	Get the glob patterns to load additional config files	ListenerOptions
getConfigStaticPaths()	Get the static paths to load additional config files	ListenerOptions
getExtraConfig()	Get any extra config to merge in.	ListenerOptions
getModuleMapCacheEnabled()	Check if the module class map cache is enabled	ListenerOptions
getModuleMapCacheFile()	Get the path to the module class map cache	ListenerOptions
getModuleMapCacheKey()	Get key used to create the cache file name	ListenerOptions
getModulePaths()	Get an array of paths where modules reside	ListenerOptions
normalizePath()	Normalize a path for insertion in the stack	ListenerOptions
setCacheDir()	Set the path where cache files can be stored	ListenerOptions
setCheckDependencies()	Set whether to check dependencies during module loading or not	ListenerOptions
setConfigCacheEnabled()	Set if the config cache should be enabled or not	ListenerOptions
setConfigCacheKey()	Set key used to create the cache file name	ListenerOptions
setConfigGlobPaths()	Set the glob patterns to use for loading additional config files	ListenerOptions
setConfigStaticPaths()	Set the static paths to use for loading additional config files	ListenerOptions
setExtraConfig()	Add some extra config array to the main config. This is mainly useful for unit testing purposes.	ListenerOptions
setFromArray()	Set one or more configuration properties	AbstractOptions
setModuleMapCacheEnabled()	Set if the module class map cache should be enabled or not	ListenerOptions
setModuleMapCacheKey()	Set key used to create the cache file name	ListenerOptions
setModulePaths()	Set an array of paths where modules reside	ListenerOptions
setUseLaminasLoader()	Set a flag indicating if the module manager should use laminas-loader	ListenerOptions
setUseZendLoader()		ListenerOptions
toArray()	Cast to array	AbstractOptions
useLaminasLoader()	Whether or not to use laminas-loader to autoload modules.	ListenerOptions
useZendLoader()		ListenerOptions

Method Details

__construct()

Constructor

Parameter Name	Type	Description
$options	array|\Traversable|null

Returns:

__get()

Get a configuration property

Parameter Name	Type	Description
$key	string

Returns: mixed

__isset()

Test if a configuration property is null

Parameter Name	Type	Description
$key	string

Returns: bool

__set()

Set a configuration property

Parameter Name	Type	Description
$key	string
$value	mixed

Returns: void

__unset()

Set a configuration property to NULL

Parameter Name	Type	Description
$key	string

Returns: void

getCacheDir()

Get the path where cache file(s) are stored

Returns: string|null

getCheckDependencies()

Set whether to check dependencies during module loading or not

Returns: bool

getConfigCacheEnabled()

Check if the config cache is enabled

Returns: bool

getConfigCacheFile()

Get the path to the config cache

Should this be an option, or should the dir option include the filename, or should it simply remain hard-coded? Thoughts?

Returns: string

getConfigCacheKey()

Get key used to create the cache file name

Returns: string

getConfigGlobPaths()

Get the glob patterns to load additional config files

Returns: array

getConfigStaticPaths()

Get the static paths to load additional config files

Returns: array

getExtraConfig()

Get any extra config to merge in.

Returns: array|\Traversable

getModuleMapCacheEnabled()

Check if the module class map cache is enabled

Returns: bool

getModuleMapCacheFile()

Get the path to the module class map cache

Returns: string

getModuleMapCacheKey()

Get key used to create the cache file name

Returns: string

getModulePaths()

Get an array of paths where modules reside

Returns: array

normalizePath()

Normalize a path for insertion in the stack

Parameter Name	Type	Description
$path	string

Returns: string

setCacheDir()

Set the path where cache files can be stored

Parameter Name	Type	Description
$cacheDir	string|null	the

Returns: \ListenerOptions

setCheckDependencies()

Set whether to check dependencies during module loading or not

Parameter Name	Type	Description
$checkDependencies	bool	the

Returns: \ListenerOptions

setConfigCacheEnabled()

Set if the config cache should be enabled or not

Parameter Name	Type	Description
$enabled	bool

Returns: \ListenerOptions

setConfigCacheKey()

Set key used to create the cache file name

Parameter Name	Type	Description
$configCacheKey	string	the

Returns: \ListenerOptions

setConfigGlobPaths()

Set the glob patterns to use for loading additional config files

Parameter Name	Type	Description
$configGlobPaths	array|\Traversable

Returns: \ListenerOptions Provides fluent interface

setConfigStaticPaths()

Set the static paths to use for loading additional config files

Parameter Name	Type	Description
$configStaticPaths	array|\Traversable

Returns: \ListenerOptions Provides fluent interface

setExtraConfig()

Add some extra config array to the main config. This is mainly useful for unit testing purposes.

Parameter Name	Type	Description
$extraConfig	array|\Traversable

Returns: \ListenerOptions Provides fluent interface

setFromArray()

Set one or more configuration properties

Parameter Name	Type	Description
$options	array|\Traversable|\AbstractOptions

Returns: \AbstractOptions Provides fluent interface

setModuleMapCacheEnabled()

Set if the module class map cache should be enabled or not

Parameter Name	Type	Description
$enabled	bool

Returns: \ListenerOptions

setModuleMapCacheKey()

Set key used to create the cache file name

Parameter Name	Type	Description
$moduleMapCacheKey	string	the

Returns: \ListenerOptions

setModulePaths()

Set an array of paths where modules reside

Parameter Name	Type	Description
$modulePaths	array|\Traversable

Returns: \ListenerOptions Provides fluent interface

setUseLaminasLoader()

Set a flag indicating if the module manager should use laminas-loader

Setting this option to false will disable ModuleAutoloader, requiring other means of autoloading to be used (e.g., Composer).

If disabled, the AutoloaderProvider feature will be disabled as well

Parameter Name	Type	Description
$flag	bool

Returns: \ListenerOptions

setUseZendLoader()

Parameter Name	Type	Description
$flag

Returns:

toArray()

Cast to array

Returns: array

useLaminasLoader()

Whether or not to use laminas-loader to autoload modules.

Returns: bool

useZendLoader()

Returns: